BGE

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source:

Classes

AnimatedImage
Canvas
CircleCollider
Collider
Drawable
DrawablePolygon
DrawableRectangle
DrawableText
Game
GameEntity
GameInput
GameTimer
Image
RectangleCollider
Room
Sprite
SpriteAnimation
TagList

Namespaces

BGE

Methods

(static) ArrayInsert(array, index, value) → {dynamic}

Parameters:
Name Type Description
array object
index integer
value dynamic
Source:

(static) BounceEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) BounceTween(start, finish, currentTime, duration) → {dynamic}

Bounce

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) buttonNameFromCode(buttonCode) → {string}

Parameters:
Name Type Description
buttonCode integer
Source:

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
dest_data dynamic
Source:

(static) CircularEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CircularTween(start, finish, currentTime, duration) → {dynamic}

Circular

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) cloneArray(originalopt) → {object}

Parameters:
Name Type Attributes Default Description
original object <optional>
[]
Source:

(static) Colors() → {object}

Source:

(static) ColorsRGB() → {object}

Source:

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {dynamic}

Copyright Steven Kean 2010-2015 All Rights Reserved.

Parameters:
Name Type Description
start_data object
dest_data object
duration integer
tween string
Source:

(static) CubicEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) CubicTween(start, finish, currentTime, duration) → {dynamic}

Cubic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) DrawCircleOutline(draw2d, line_count, x, y, radius, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
line_count integer
x float
y float
radius float
rgba integer
Source:

(static) DrawRectangleOutline(draw2d, x, y, width, height, rgba) → {dynamic}

Parameters:
Name Type Description
draw2d object
x float
y float
width float
height float
rgba integer
Source:

(static) DrawScaledAndRotatedObject(draw2d, x, y, scale_x, scale_y, theta, drawable, coloropt) → {void}

NOTE: This function is unsafe! It creates an roBitmap of the required size to be able to both scale and rotate the drawing, this action requires free video memory of the appropriate amount.

Parameters:
Name Type Attributes Default Description
draw2d object
x float
y float
scale_x float
scale_y float
theta float
drawable object
color integer <optional>
-1
Source:

(static) DrawText(draw2d, text, x, y, font, alignmentopt, coloropt) → {void}

Parameters:
Name Type Attributes Default Description
draw2d object
text string
x integer
y integer
font object
alignment string <optional>
"left"
color integer <optional>
-1
Source:

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
amplitude dynamic <optional>
invalid
period dynamic <optional>
invalid
Source:

(static) ElasticTween(start, finish, currentTime, duration) → {dynamic}

Elastic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) ExponentialTween(start, finish, currentTime, duration) → {dynamic}

Exponential

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) GetColor(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) GetColorRGB(name) → {integer}

Parameters:
Name Type Description
name string
Source:

(static) getNumberOfLinesInAString(text) → {integer}

Parameters:
Name Type Description
text string
Source:

(static) GetTweenObjectPercentState(tween_object) → {dynamic}

Parameters:
Name Type Description
tween_object object
Source:

(static) GetTweens() → {object}

Source:

(static) HandleTween(tween_data) → {dynamic}

Parameters:
Name Type Description
tween_data dynamic
Source:

(static) HSVtoRGBA(hPercent, sPercent, vPercent, aopt) → {integer}

Parameters:
Name Type Attributes Default Description
hPercent dynamic
sPercent dynamic
vPercent dynamic
a dynamic <optional>
invalid
Source:

(static) isValidEntity(entity) → {boolean}

Parameters:
Name Type Description
entity object
Source:

(static) lastInStr(text, substring) → {integer}

Parameters:
Name Type Description
text string
substring string
Source:

(static) LinearTween(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) Math_Atan2(y, x) → {float}

Parameters:
Name Type Description
y float
x float
Source:

(static) Math_Clamp(number, min, max) → {dynamic}

Parameters:
Name Type Description
number dynamic
min dynamic
max dynamic
Source:

(static) Math_DegreesToRadians(degrees) → {float}

Parameters:
Name Type Description
degrees float
Source:

(static) Math_GetAngle(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) Math_IsIntegerEven(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_IsIntegerOdd(number) → {boolean}

Parameters:
Name Type Description
number integer
Source:

(static) Math_Max(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_Min(a, b) → {dynamic}

Parameters:
Name Type Description
a dynamic
b dynamic
Source:

(static) Math_NewCircle(x, y, radius) → {object}

Parameters:
Name Type Description
x integer
y integer
radius float
Source:

(static) Math_NewRectangle(x, y, width, height) → {object}

Parameters:
Name Type Description
x integer
y integer
width integer
height integer
Source:

(static) Math_NewVector(xopt, yopt) → {object}

Parameters:
Name Type Attributes Default Description
x dynamic <optional>
0
y dynamic <optional>
0
Source:

(static) Math_PI() → {float}

Source:

(static) Math_Power(number, pow) → {dynamic}

Parameters:
Name Type Description
number dynamic
pow integer
Source:

(static) Math_RadiansToDegrees(radians) → {float}

Parameters:
Name Type Description
radians float
Source:

(static) Math_RandomRange(lowest_int, highest_int) → {integer}

Parameters:
Name Type Description
lowest_int integer
highest_int integer
Source:

(static) Math_RotateVectorAroundVector(vector1, vector2, radians) → {object}

Parameters:
Name Type Description
vector1 object
vector2 object
radians float
Source:

(static) Math_Round(number, decimalsopt) → {float}

Parameters:
Name Type Attributes Default Description
number float
decimals integer <optional>
0
Source:

(static) Math_TotalDistance(vector1, vector2) → {float}

Parameters:
Name Type Description
vector1 object
vector2 object
Source:

(static) NumberToFixed(num, precision) → {string}

Parameters:
Name Type Description
num float
precision integer
Source:

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
overshoot float <optional>
1.70158
Source:

(static) OvershootTween(start, finish, currentTime, duration) → {dynamic}

Overshoot

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuadraticTween(start, finish, currentTime, duration) → {dynamic}

Quadratic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuarticTween(start, finish, currentTime, duration) → {dynamic}

Quartic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) QuinticTween(start, finish, currentTime, duration) → {dynamic}

Quintic

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) registryRead(registry_section, key, default_valueopt) → {dynamic}

Parameters:
Name Type Attributes Default Description
registry_section string
key string
default_value dynamic <optional>
invalid
Source:

(static) registryWrite(registry_section, key, value) → {void}

Parameters:
Name Type Description
registry_section string
key string
value dynamic
Source:

(static) RGBAtoRGBA(red, green, blue, alphaopt) → {integer}

Parameters:
Name Type Attributes Default Description
red integer
green integer
blue integer
alpha float <optional>
1
Source:

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SinusoidalTween(start, finish, currentTime, duration) → {dynamic}

Sinusoidal

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseInOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOut(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {dynamic}

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) SquareTween(start, finish, currentTime, duration) → {dynamic}

Square

Parameters:
Name Type Description
start dynamic
finish dynamic
currentTime dynamic
duration dynamic
Source:

(static) TexturePacker_GetRegions(atlas, bitmap) → {object}

Parameters:
Name Type Description
atlas dynamic
bitmap object
Source: